API docs by Redocly

Consularia Connect API (1.0.0 (v1))

Download OpenAPI specification:

Consularia Support: support@consularia.dev License: Proprietary

API for managing video appointments and participants

Appointments

appointments_list

List appointments for the authenticated organization. Supports filtering by participant_unique_id, start_date, and end_date

Authorizations:
ApiTokenAuthApiTokenAuth
query Parameters
end_date
string <date-time>
page
integer
participant_unique_id
string
start_date
string <date-time>

Responses

Response samples

Content type
application/json
{}

appointments_create

Create a new appointment. Returns appointment details on success.

Authorizations:
ApiTokenAuthApiTokenAuth
Request Body schema:
required
title
required
string [ 1 .. 255 ] characters

Appointment title

start_date_time
required
string <date-time>

Appointment start datetime (UTC)

duration_minutes
required
integer [ 15 .. 720 ]

Duration in minutes

required
Array of objects (AppointmentParticipantDetailRequest)
object or null

Optional configuration for this appointment. Available fields: breakout_rooms_enabled, whiteboard_enabled, chat_enabled, join_screen_enabled, screenshare_enabled, raise_hand_enabled. Example: {"breakout_rooms_enabled": false, "chat_enabled": true}

Responses

Request samples

Content type
{
  • "title": "Consultation Meeting",
  • "start_date_time": "2025-10-30 15:26:22.539536+00:00",
  • "duration_minutes": 60,
  • "participants": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "title": "string",
  • "start_date_time": "2019-08-24T14:15:22Z",
  • "duration_minutes": 15,
  • "status": "string",
  • "config": {
    },
  • "participants": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

appointments_retrieve

Retrieve appointment details including participants.

Authorizations:
ApiTokenAuthApiTokenAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this appointment.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "title": "string",
  • "start_date_time": "2019-08-24T14:15:22Z",
  • "duration_minutes": 15,
  • "status": "string",
  • "config": {
    },
  • "participants": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

appointments_partial_update

Partially update appointment fields. Active and completed appointments cannot be updated.

Authorizations:
ApiTokenAuthApiTokenAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this appointment.

Request Body schema:
title
string [ 1 .. 255 ] characters

Appointment title

start_date_time
string <date-time>

Appointment start datetime (UTC)

duration_minutes
integer [ 15 .. 720 ]

Duration in minutes

object or null

Optional configuration for this appointment. Available fields: breakout_rooms_enabled, whiteboard_enabled, chat_enabled, join_screen_enabled, screenshare_enabled, raise_hand_enabled. Example: {"breakout_rooms_enabled": false, "chat_enabled": true}

Responses

Request samples

Content type
{
  • "title": "Updated Appointment Title"
}

Response samples

Content type
application/json
{
  • "title": "Updated Appointment Title"
}

appointments_destroy

Delete an appointment.

Authorizations:
ApiTokenAuthApiTokenAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this appointment.

Responses

Participants

appointments_participants_list

List all participants for an appointment.

Authorizations:
ApiTokenAuthApiTokenAuth
path Parameters
id
required
string <uuid>
query Parameters
page
integer

Responses

Response samples

Content type
application/json
{}

appointments_participants_retrieve

Retrieve a participant's details.

Authorizations:
ApiTokenAuthApiTokenAuth
path Parameters
id
required
string <uuid>
participant_id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "unique_id": "string",
  • "display_name": "string",
  • "role": "moderator",
  • "access_link": "http://example.com"
}

appointments_participants_partial_update

Partially update a participant's details.

Authorizations:
ApiTokenAuthApiTokenAuth
path Parameters
id
required
string <uuid>
participant_id
required
string <uuid>
Request Body schema:
display_name
string or null <= 60 characters

Display name for the participant

role
string
Enum: "moderator" "participant"

Role of the participant

  • moderator - Moderator
  • participant - Participantsaga

Responses

Request samples

Content type
{
  • "display_name": "Updated Name"
}

Response samples

Content type
application/json
{
  • "display_name": "Updated Name"
}

appointments_participants_destroy

Remove a participant from an appointment.

Authorizations:
ApiTokenAuthApiTokenAuth
path Parameters
id
required
string <uuid>
participant_id
required
string <uuid>

Responses

appointments_participants_add_create

Add multiple participants to an appointment.

Authorizations:
ApiTokenAuthApiTokenAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this appointment.

Request Body schema:
required
unique_id
required
string [ 1 .. 255 ] characters

Unique participant identifier (email, username, etc.)

display_name
string <= 60 characters

Display name for the participant

role
required
string
Enum: "moderator" "participant"

Role of the participant

  • moderator - Moderator
  • participant - Participantsaga

Responses

Request samples

Content type
[
  • {
    },
  • {
    }
]

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "title": "string",
  • "start_date_time": "2019-08-24T14:15:22Z",
  • "duration_minutes": 15,
  • "status": "string",
  • "config": {
    },
  • "participants": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

appointments_participants_remove_create

Remove multiple participants from an appointment.

Authorizations:
ApiTokenAuthApiTokenAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this appointment.

Request Body schema:
required
id
required
string <uuid>

UUID of participant to remove

Responses

Request samples

Content type
[
  • {
    },
  • {
    }
]

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "title": "string",
  • "start_date_time": "2019-08-24T14:15:22Z",
  • "duration_minutes": 15,
  • "status": "string",
  • "config": {
    },
  • "participants": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}